home *** CD-ROM | disk | FTP | other *** search
- SCRIPTING LANGUAGE DOCUMENTATION
-
-
- This file documents the scripting language supported by AT&T Mail Access PLUS
- and AT&T Mail Access PLUS for Windows.
-
- Each line in a script file represents a command to be executed by the AT&T
- Background Mailer (BGMAIL), Access, or the Online application of Access PLUS
- for Windows. The syntax and meaning of each command is as follows:
-
- BREAK [<h-seconds>] Send a BREAK signal for a <h-seconds>
- hundreths of a second duration. The
- default without optional argument is
- 12/100 or .12 of a second (e.g.
- BREAK 12)
-
- DELAY <#-seconds> Delay script execution for <#-seconds>
- seconds.
-
- DISPLAY "<string>" Display <string> on BGMAIL status line
- or in Background Mailer Status window.
- Quotes are required but not displayed.
-
- DO <script-file> Continue script execution using script
- commands in the file <script-file>.
- The file must reside in the Access
- PLUS program directory. Execution
- does not return to the calling script.
-
- DTR { ON | OFF } Toggle COM port DTR state on or off.
-
- ECHO { ON | OFF } Echo SEND/WAIT strings. Obsolete and
- does nothing currently.
-
- IFGOT { 1 | 2 | 3 } SKIP <#-lines> Transfer control <#-lines> down if
- WAIT parameter <string-1>, <string-2>,
- or <string-3> was received. Used after
- a WAIT command. Comments lines do not
- count.
-
- IFONLINE SKIP <#-lines1> OR <#-lines2> Used for conditional control for a user
- who goes Online and uses Information
- Services menu. Pressing 1 <CR> (for
- AT&T Mail) will skip <#-lines2> lines
- down. Pressing anything else will skip
- <#-lines1> lines down. See LOGON.SCR
- for example.
-
- RESET Reset an internal Hayes Smartmodem, if
- installed, along with the COM port
- hardware.
-
- SEND <#-seconds> "<string>" Send <string> with <#-seconds> second
- delay before every character is sent.
- Use 0 for <#-seconds> for no delay.
- Quotes are required but not sent.
-
- SKIP <#-lines> Transfer control <#-lines> down
- unconditionally. Comments lines do
- not count.
-
- WAIT <#-seconds> "<string-1>" Wait for <string-1>, <string2>, or
- [ OR "<string-2>" <string-3> no longer than <#-seconds>.
- [ OR "<string-3>" ] ] Use IFGOT to test which string was
- received. Quotes are required but not
- part of the strings.
-
- *[<text>] Comment line. Must start in column 1.
- Not counted by SKIPs.
-
-
- NOTE: <#-seconds> above can be specified in whole seconds (for example, 1, 20,
- or 90), in tenths or hundredths (for example, .5, 0.1, or .12), or mixed
- (for example, 1.5 or 6.25).
-
- Several character sequences have special meaning in a SEND, WAIT, or DISPLAY
- command string parameter and are replaced with values as follows:
-
- $A, $B, $C User-defined parameters #1, #2, and #3 from
- configuration, respectively.
- $L Login name from configuration.
- $M Mail service password from configuration.
- $N Dial prefix, if defined, and dial number from
- configuration.
- $P Password from configuration.
- $S Replaced with the string "AT&T Mail" (without quotes).
- $$ Replaced by a single $ character.
-
- ^X ASCII Control X character (where 'X' can be from A to Z)
- For example, ^M = ASCII 13 = Carriage Return
-